Document Upload

PURPOSE

This method allows the partner to upload documents of the prospect for further verification and subsequent acceptance and disbursal of the loan. It takes category, sub-category of the document as per the master list and the document name, extension and file converted into Base64 string. This API responds with an error message on failure, detailed list of which is described here.

Request URL

https://apisandbox.iifl.in/fintech/DocumentUpload

Request Method: POST

Request format: JSON

Request Header

Content-Type: application/json

Ocp-Apim-Subscription-Key: provided by IIFL

Request Response(200) Response(Failure)

REQUEST BODY

HEADER

Field Name Description Data Type
(max length)		 Mandatory Sample Value
requestCode Request Code of the API called Varchar Yes FTRQDOC01
appVer Developer App Version Varchar Yes 1.0
key UserKey generated at the time of registration Varchar Yes ABpyyGUh1nsbesSlup3VKURkI4tQDe8y
osName Channel of order Varchar Yes WebAPI, Android, iOS
appName App Name provided at the time of registration Varchar Yes ALLIANCE
source Source provided at the time of registration Varchar Yes 321

BODY

Field Name Description Data Type
(max length)		 Mandatory Sample Value
ProspectNo Prospect Number provided while prospect creation Varchar (10) Yes 78946123
ApplicantType Type of applicant Varchar(20) Yes APPLICANT
CatID Category ID of the document Varchar(5) Yes 1
SubCatID Sub Category ID of the document Varchar(5) Yes 2
Base64String File Converted in base64 String Varchar(MAX) Yes
ImageName Name of the image Varchar(25) Yes Aadhar
Extension File Extension Varchar(5) Yes .jpg

Category Master

Category ID Category Name
1 IDProof
2 AddressProof
5 OwnershipType
6 EntityProof

Sub Category Master

Sub Category ID SubCatName Category ID
1 PAN 1
2 Aadhar 1
3 Voters ID 1
4 Passport 1
4 Passport 1
5 Aadhar 2
6 Voters ID 2
7 Passport 2
16 Electricity bill 5
17 Water bill 5
18 Sales Deed 5
19 Society maintainanceBill 5
20 Property Tax Bill 5
21 Marriage Certificate 6
22 Birth Certificate 6
23 Any KYC document 6

RESPONSE BODY

HEAD

Field Name Description Data Type
(max length)		 List of Values Sample Value
responseCode This is the response code of API Varchar(20) - FTRSRS01
status This is the response code of API Varchar(10) 0 - Success
1 - Fail 		0
Source This is the Partner’s name Varchar(20) - Partner_Name
statusDescription Description of the response status Varchar(50) - -
success_user_status Status of the user for a partner Varchar(10) 0 - Success
1 - Fail		 0

BODY

Field Name Description Data Type
(max length)		 Sample Value
prospectno Prospect Number Varchar(15) SL12345678
CRMLeadID CRM Lead ID Varchar(15) 89457895

REQUEST:

{
  "head": {
    "requestCode": "FTRQDOC01",
    "key": "abcdefghi12345678jklmno",
    "appVer": "1.0",
    "osName": "WebAPI",
    "appName": "ALLIANCE",
    "source": "PartnerName"
  },
  "body": {
    "ProspectNumber": "SL1066537",
    "ApplicantType": "APPLICANT",
    "CatID": "1",
    "SubCatID": "1",
    "Base64string": "(File converted into Base64 string)",
    "ImageName": "abc",
    "Extension": "jpg"
  }
}

Response (Success)

{
  "head": {
    "response_code": "FTRSDOC01",
    "source": "PartnerName",
    "status": "0",
    "status_description": "Success",
    "success_user_status": "0"
  },
  "body": {
    "CRMLeadId": "1734809",
    "prospectno": "SL1066537"
  }
}

Response (Failure)

{
  "head": {
    "response_code": "FTRSDOC01",
    "source": "PartnerName",
    "status": "1",
    "status_description": "E56-Error while Creating Documents File",
    "success_user_status": "1"
  },
  "body": {
    "CRMLeadId": null,
    "prospectno": null
  }
}